ValidateTemplate
Description
call the ValidateTemplate interface to update the template.
Request Method
POST
Request Path
/apsara/route/ROS/ValidateTemplate
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| TemplateURL | BODY | string | No | oss://ros/template/demo | the location of the file containing the template body. The URL must point to the template located in the Web server (HTTP or HTTPS) or Aliyun OSS bucket (for example, oss:// ros/template/demo, oss:// ros/template/demo?RegionId = cn-hangzhou), the maximum template is 524 and 288 bytes. If the OSS region is not specified, the default is the same as the interface parameter RegionId. description you must specify TemplateBody or TemplateURL parameters, but not at the same time. the maximum length of the URL is: 1024 bytes. |
| Description | BODY | string | No | It is a demo. | description of the template. The maximum length is 256 characters. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| TemplateName | BODY | string | No | MyTemplate | the name of the template. must be no more than 255 characters in length and must start with a number or an English letter, which can contain numbers, English letters, dashes (-), and underscores (_). |
| TemplateBody | BODY | string | No | {"ROSTemplateFormatVersion":"2015-09-01"} | the structure of the template. The length is 1~524 and 288 bytes. /p> p data-tag = "p" class = "p"> if the length is large, it is recommended to pass the parameters in the request body through HTTP POST + Body Param to avoid the request failure caused by the URL being too long. description you must specify the parameter TemplateBody or TemplateURL, but not at the same time. |
| version | BODY | string | No | 2016-01-01 | version of api |
| TemplateId | BODY | string | Yes | 5ecd1e10-b0e9-4389-a565-e4c15efc**** | template ID. |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| RequestID | string | 1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC | Request id |
Example
Successful Response example
{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}
title: ValidateTemplate
sidebar_position: 3
ValidateTemplate
Description
call the ValidateTemplate interface to verify the template on which the resource stack will be created.
Request Method
POST
Request Path
/apsara/route/ROS/ValidateTemplate
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| TemplateURL | BODY | string | No | oss://ros/template/demo | the location of the file containing the template body. The URL must point to the template located in the Web server (HTTP or HTTPS) or Aliyun OSS bucket (for example, oss:// ros/template/demo, oss:// ros/template/demo?RegionId = cn-hangzhou), the maximum template is 524 and 288 bytes. If the OSS region is not specified, the default is the same as the interface parameter RegionId. description you must specify TemplateBody or TemplateURL parameters, but not at the same time. the maximum length of the URL is: 1024 bytes. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| RegionId | BODY | string | No | cn-hangzhou | the region ID to which the resource stack template belongs. |
| TemplateBody | BODY | string | No | {"ROSTemplateFormatVersion":"2015-09-01"} | the structure of the template. The length is 1~524 and 288 bytes. /p> p data-tag = "p" class = "p"> if the length is large, it is recommended to pass the parameters in the request body through HTTP POST + Body Param to avoid the request failure caused by the URL being too long. description you must specify the parameter TemplateBody or TemplateURL, but not at the same time. |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| RequestID | string | 1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC | Request id |
Example
Successful Response example
{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}